/**
********************************************************************************
\file   boot/internal/handshake.h

\brief  Internal header of the handshake module.

The handshake module ensures a synchronous boot-up of both the uP-Master and
uP-Slave. It uses the upserial module to communicate with the other
processor.

*******************************************************************************/

/*------------------------------------------------------------------------------
Copyright (c) 2014, B&R Industrial Automation GmbH
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the copyright holders nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
------------------------------------------------------------------------------*/

#ifndef _INC_boot_internal_handshake_H_
#define _INC_boot_internal_handshake_H_

/*----------------------------------------------------------------------------*/
/* includes                                                                   */
/*----------------------------------------------------------------------------*/
#include <sn/global.h>


/*----------------------------------------------------------------------------*/
/* const defines                                                              */
/*----------------------------------------------------------------------------*/
#define WELCOME_MSG_CONTENT     0xDEADBEEF      /**< Data of the welcome message */

#define RESTORE_SOD_STATE_BIT   0               /**< Restore SOD bit offset */

/*----------------------------------------------------------------------------*/
/* typedef                                                                    */
/*----------------------------------------------------------------------------*/

/**
 * \brief Content of the welcome message up-Slave -> up-Master
 */
typedef struct
{
    UINT32 msgHeader_m;     /**< The header of the message (Filled with \ref WELCOME_MSG_CONTENT) */
    UINT16 snState_m;       /**< The SN state parameter */
} tWelcMsg;

/**
 * \brief Content of the response message up-Master -> up-Slave
 */
typedef struct
{
    UINT32 msgHeader_m;     /**< The header of the message which was returned by uP-Master */
    UINT16 snState_m;       /**< The SN state parameter */
} tRespMsg;

/*----------------------------------------------------------------------------*/
/* function prototypes                                                        */
/*----------------------------------------------------------------------------*/

#ifdef __cplusplus
    extern "C" {
#endif

void hands_verifySnStateField(UINT16 snState_p, BOOLEAN * pRestoreSod_p);
void hands_fillStateField(volatile UINT16* pSnState_p, BOOLEAN * pRestoreSod_p);

#ifdef __cplusplus
    }
#endif


#endif /* _INC_boot_internal_handshake_H_ */
